Improve .cbor control validation failure message#148
Open
Improve .cbor control validation failure message#148
.cbor control validation failure message#148Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves .cbor control validation failures so they are reported as an unsatisfied control (instead of throwing a runtime "Not yet implemented" error), and adds golden coverage to lock in the new behavior.
Changes:
- Make
.cborbyte-string control validation returnFalseon decode/validation failure, allowing the validator to emitUnsatisfiedControlrather than crashing. - Add a new Huddle example and golden test (
cborControlBad) to validate the improved error output. - Refactor the generator test example naming/exports to use
customGenExampleinstead ofsimpleTermExample.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/Codec/CBOR/Cuddle/CBOR/Validator.hs |
Replaces the .cbor control’s runtime error with a normal validation failure (False). |
test/Test/Codec/CBOR/Cuddle/CDDL/Validator/Golden.hs |
Adds a golden test case that triggers an unsatisfied .cbor control. |
test/Test/Codec/CBOR/Cuddle/CDDL/Examples/Huddle.hs |
Introduces cborControlExample and renames the custom generator example exports. |
test/Test/Codec/CBOR/Cuddle/CDDL/GeneratorSpec.hs |
Updates generator specs to reference customGenExample. |
golden/cborControlBad.txt |
Captures the expected pretty-printed error output for the failing .cbor control. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Soupstraw
force-pushed
the
jj/cbor-control-fix
branch
from
719bddc to
c9aaa1d
Compare
Soupstraw
force-pushed
the
jj/cbor-control-fix
branch
from
c9aaa1d to
3af1905
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improved error messages for failing
.cborvalidation. It now displays that a.cborcontrol is unsatisfied instead of throwing a "Not implemented" error.Related: IntersectMBO/ouroboros-consensus#1892